Skip to main content

Create business document

POST /api/v1/BusinessesDocuments/create

Description​

This endpoint allows the creation of a new business document.

Request​

-Path

/api/v{version}/BusinessesDocuments/create

Headers​

  • Accept-Language: Change default response message language from English(en). Available languages fr,en

Path Parameters​

  • version: API version.

Request Body​

jsonCopy code{
  "schema": {
    "$ref": "#/components/schemas/CreateBusinessDocumentRequest"
  }
}

Response​

Success (200)​
jsonCopy code{
  "schema": {
    "$ref": "#/components/schemas/BusinessDocumentResponse"
  }
}

/api/v1/BusinessesDocuments/create

Headers​

Content-TypeValue
Accept-Language

Headers​

Content-TypeValue
Content-Typeapplication/json

Headers​

Content-TypeValue
Accepttext/plain

Body (raw)​

{
  "businessId": `<uuid>`,
  "type": 2,
  "base64": `<string>`,
  "fileName": `<string>`,
  "documentNumber": `<string>`
}

Response: 200​

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": {
    "id": `<uuid>`,
    "businessId": `<uuid>`,
    "type": 2,
    "path": `<string>`,
    "fileName": `<string>`,
    "documentNumber": `<string>`,
    "approved": `<boolean>`
  }
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request POST \ 
 --url  /api/v1/BusinessesDocuments/create \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!